home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 626-637 / disk_627 / adoc / amigaenglish.doc < prev    next >
Text File  |  1992-05-06  |  43KB  |  1,437 lines
  1.   File of documentation for ADoc
  2.   Rough English translation by Simon HEWISON (don't blame me if it's wrong !)
  3.   Revised by Denis GOUNELLE
  4.   All commercial use or selling of this file is forbidden.
  5.  
  6.   Contents : Intuition.library, main functions and structures
  7.          Dos.library, main functions and structures
  8.          (sorry, I didn't have the courage to add Exec functions...)
  9.  
  10. AddGadget (Intuition function)
  11.  
  12.   Synopsis    : position = AddGadget( window , gadget, position )
  13.  
  14.   Inputs      : window (a0) pointer to a Window structure
  15.         gadget (a1) pointer to a Gadget structure
  16.         position (d0) value
  17.  
  18.   Outputs     : position (d0) value
  19.  
  20.   Description : Adds a gadget into the list of gadgets of the window
  21.         indicated at the position demanded, and returns the position
  22.         at which the gadget has actually been inserted.
  23.         A position of 0 signifies "at head of the list", a position
  24.         of n signifies "after the n-th gadget".
  25.         The gadget is not displayed until you call RefreshGadgets.
  26.  
  27.   See also    : Gadget, RefreshGadgets, RemoveGadget.
  28.  
  29. AllocRemember (Intuition function)
  30.  
  31.   Synopsis    : pointer = AllocRemember( remember , size , type )
  32.  
  33.   Inputs      : remember (a0) address of a pointer to a Remember structure
  34.         size (d0) value
  35.         type (d1) value
  36.  
  37.   Outputs     : pointer (d0) pointer to a long word
  38.  
  39.   Description : Like the function AllocMem, allocates an area memory of
  40.         <size> bytes of type <type> and returns a pointer to
  41.         that area, or NULL if the allocation was impossible.
  42.         One good thing is the remember structures are linked
  43.         together : all memory you have allocated can be freed with
  44.         a single call to the function FreeRemember.
  45.         Before you call AllocRemember for the first time, <remember>
  46.         should be set to NULL.
  47.  
  48.   See also    : AllocMem, FreeRemember.
  49.  
  50. AutoRequest (Intuition function)
  51.  
  52.   Synopsis    :  response = AutoRequest( window, message, txt_pos, txt_neg,
  53.                    IDCMP_pos, IDCMP_neg, width, height )
  54.  
  55.   Inputs      : window (a0) pointer to a Window structure
  56.         message (a1) pointer to an IntuiText structure
  57.         txt_pos (a2) pointer to an IntuiText structure
  58.         txt_neg (a3) pointer to an IntuiText structure
  59.         IDCMP_pos (d0) IDCMP flags
  60.         IDCMP_neg (d1) IDCMP flags
  61.         width (d2) value
  62.         height (d3) value
  63.  
  64.   Outputs     : response (d0) boolean
  65.  
  66.   Description : Adds a requester box with the given message and two
  67.         gadgets containing the messages <txt_pos> and <txt_neg>. The
  68.         size of the box is fixed by <width> and <height>.
  69.         The response is TRUE if clicked on the gadget containing
  70.         txt_pos or if a message arrives which corresponds to
  71.         IDCMP_pos. The response is FALSE if clicked on the gadget
  72.         containing txt_neg or if a message arrives which corresponds
  73.         to IDCMP_neg.
  74.  
  75.   See also    : BuildSysRequest, IDCMP, IntuiText.
  76.  
  77. BeginRefresh (Intuition function)
  78.  
  79.   Synopsis    : BeginRefresh( window )
  80.  
  81.   Inputs      : window (a0) pointer to a Window structure
  82.  
  83.   Description : Prepare the given window for queue for refreshing
  84.         by ourself (rather than by Intuition).
  85.  
  86.   See also    : EndRefresh.
  87.  
  88. BuildSysRequest (Intuition function)
  89.  
  90.   Synopsis    :  reponse = BuildSysRequest( window , message , text_pos ,
  91.                     text_neg , IDCMP , width , height )
  92.  
  93.   Inputs      : window (a0) pointer to a Window structure
  94.         message (a1) pointer to an IntuiText structure
  95.         text_pos (a2) pointer to an IntuiText structure
  96.         text_neg (a3) pointer to an IntuiText structure
  97.         IDCMP (d0) IDCMP port
  98.         width (d1) value
  99.         height (d2) value
  100.  
  101.   Outputs     : response (d0) boolean or pointer to a Window structure
  102.  
  103.   Description : Open a window on the screen which contains the given window
  104.         and add the text <message> and two gadgets containing the
  105.         messages <text_pos> and <text_neg>. The size of the window is
  106.         set by <width> and <height>, and its IDCMPFlags to the value
  107.         of <IDCMP>.
  108.         If all went well, the value returned is a pointer to a
  109.         structure Window, otherwise the function DisplayAlert is
  110.         called, and the value returned is TRUE or FALSE.
  111.  
  112.   See also    : AutoRequest, DisplayAlert, IDCMP, IntuiText.
  113.  
  114. Border (Intuition structure)
  115.  
  116.     struct Border {
  117.       SHORT  LeftEdge , TopEdge;  /* x,y of the starting point */
  118.       UBYTE  FrontPen , BackPen;  /* line colour, unused */
  119.       UBYTE  DrawMode ;          /* JAM1 or XOR */
  120.       BYTE     Count ;          /* number of coords into XY */
  121.       SHORT  *XY ;              /* address of an array of coords */
  122.       struct Border *NextBorder ; /* ptr to next structure definition */
  123.       } ;
  124.  
  125.     See also   : DrawBorder, Gadget.
  126.  
  127. ClearDMRequest (Intuition function)
  128.  
  129.   Synopsis    : response = ClearDMRequest( window )
  130.  
  131.   Inputs      : window (a0) pointer to a Window structure
  132.  
  133.   Outputs     : response (d0) boolean
  134.  
  135.   Description : Attempt to clear the DMRequester associated with the
  136.         given window.
  137.         Returns TRUE if all went well, and FALSE if not.
  138.  
  139.   See also    : SetDMRequest.
  140.  
  141. ClearMenuStrip (Intuition function)
  142.  
  143.   Synopsis    : ClearMenuStrip( window )
  144.  
  145.   Inputs      : window (a0) pointer to a Window structure
  146.  
  147.   Description : Clear the menu bar of the given window.
  148.  
  149.   See also    : SetMenuStrip.
  150.  
  151. ClearPointer (Intuition function)
  152.  
  153.   Synopsis    : ClearPointer( window )
  154.  
  155.   Inputs      : window (a0) pointer to a Window structure
  156.  
  157.   Description : Reset the definition of the mouse pointer to the default
  158.         for the given window.
  159.  
  160.   See also    : SetPointer.
  161.  
  162. Close (Dos function)
  163.  
  164.   Synopsis    : Close( file )
  165.  
  166.   Inputs      : file (d1) pointer to a FileHandle structure
  167.  
  168.   Description : Close the given file.
  169.  
  170.   See also    : Open.
  171.  
  172. CloseScreen (Intuition function)
  173.  
  174.   Synopsis    : CloseScreen( screen )
  175.  
  176.   Inputs      : screen (a0) pointer to a Screen structure
  177.  
  178.   Description : Close the given screen.
  179.  
  180.   See also    : OpenScreen.
  181.  
  182. CloseWindow (Intuition function)
  183.  
  184.   Synopsis    : CloseWindow( window )
  185.  
  186.   Inputs      : window (a0) pointer to a Window structure
  187.  
  188.   Description : Close the given window.
  189.  
  190.   See also    : OpenWindow.
  191.  
  192. CloseWorkBench (Intuition function)
  193.  
  194.   Synopsis    : result = CloseWorkBench()
  195.  
  196.   Outputs     : result (d0) boolean
  197.  
  198.   Description : Attempt to close the WorkBench screen.
  199.         Returns TRUE if all went well, FALSE if not.
  200.  
  201.   See also    : OpenWorkBench.
  202.  
  203. CreateDir (Dos function)
  204.  
  205.   Synopsis    : lock = CreateDir( name )
  206.  
  207.   Inputs      : name (d1) pointer to a string of characters
  208.  
  209.   Outputs     : lock (d0) pointer to a FileLock structure
  210.  
  211.   Description : Create a directory of name indicated, and returns a read lock
  212.         for that directory, or 0 in case of error.
  213.  
  214.   See also    : Lock.
  215.  
  216. CreateProc (Dos function)
  217.  
  218.   Synopsis    : proc = CreateProc( name , pri , segment , size )
  219.  
  220.   Inputs      : name (d1) pointer to a string of characters
  221.         pri (d2) value
  222.         segment (d3) pointer to a list of segments
  223.         size (d4) value
  224.  
  225.   Outputs     : proc (d0) process identifier
  226.  
  227.   Description : Create a process of name <name> and of priority <pri> with
  228.         the given segment list, and a stack of <size> bytes.
  229.         Returns a process identifier, or 0 in case of error.
  230.  
  231.   See also    : LoadSeg.
  232.  
  233. CurrentDir (Dos function)
  234.  
  235.   Synopsis    : lock1 = CurrentDir( lock2 )
  236.  
  237.   Inputs      : lock2 (d1) pointer to a FileLock structure
  238.  
  239.   Outputs     : lock1 (d0) pointer to a FileLock structure
  240.  
  241.   Description : The directory designated by <lock2> becomes the current
  242.         directory, and a lock on the old current directory is
  243.         returned in <lock1> (if this returns NULL, it means it is
  244.         the root of the startup volume).
  245.  
  246.   See also    : Lock.
  247.  
  248. CurrentTime (Intuition function)
  249.  
  250.   Synopsis    : CurrentTime( seconds, micros )
  251.  
  252.   Inputs      : seconds (a0) - pointer to a ULONG
  253.         micros (a1) - pointer to a ULONG
  254.  
  255.   Description : Copies the current time to the specified locations.
  256.  
  257.   See also    : DateStamp.
  258.  
  259. DateStamp (Dos function)
  260.  
  261.   Synopsis    : DateStamp( date )
  262.  
  263.   Inputs      : date (d1) pointer to three consequetive longwords
  264.  
  265.   Description : Returns the current time to the specified area, in the form
  266.         of three long words. The first indicates the number of days
  267.         from the 1st January 1978, the second the number of minutes
  268.         from midnight, and the third the number of 50ths of
  269.         seconds into the present minute.
  270.  
  271.   See also    : CurrentTime.
  272.  
  273. Delay (Dos function)
  274.  
  275.   Synopsis    : Delay( delay )
  276.  
  277.   Inputs      : delay (d1) value
  278.  
  279.   Description : Stop the current process for <delay> 50-ths of seconds
  280.  
  281. DeleteFile (Dos function)
  282.  
  283.   Synopsis    : result = DeleteFile( name )
  284.  
  285.   Inputs      : name (d1) pointer to a string of characters
  286.  
  287.   Outputs     : result (d0) boolean
  288.  
  289.   Description : Delete the given file or the directory.
  290.         Returns 0 in case of failure, -1 in case of success.
  291.  
  292. DeviceProc (Dos function)
  293.  
  294.   Synopsis    : proc = DeviceProc( name )
  295.  
  296.   Inputs      : name (d1) pointer to a string of characters
  297.  
  298.   Outputs     : proc (d0) process identifier
  299.  
  300.   Description : Search the process using the given device.
  301.         Returns an process identifier, or 0.
  302.         If <name> is referring to a volume, the IoErr function will
  303.         give you a read lock on the root of this volume.
  304.  
  305.   See also    : IoErr.
  306.  
  307. DisplayAlert (Intuition function)
  308.  
  309.   Synopsis    : result = DisplayAlert( flag , message , height )
  310.  
  311.   Inputs      : flag (d0) - value (RECOVERY_ALERT or DEADEND_ALERT)
  312.         message (a0) - pointer to the text of the alert
  313.         height (d1) - value
  314.  
  315.   Outputs     : result (d0) TRUE or FALSE
  316.  
  317.   Description : Display an alert. The size of the Box is given by
  318.         <height>, and the text has the format :
  319.             - two bytes for the x coordinate
  320.             - a byte for the y coordinate
  321.             - string terminated by a nul byte
  322.             - a byte of continuation (if not zero,
  323.               another text line follows)
  324.         Returns FALSE if flag is DEADEND_ALERT. If flag is
  325.         RECOVERY_ALERT, returns TRUE on a left button click,
  326.         and FALSE on a right button click.
  327.  
  328. DisplayBeep (Intuition function)
  329.  
  330.   Synopsis    : DisplayBeep( screen )
  331.  
  332.   Inputs      : screen (a0) pointer to a structure Screen
  333.  
  334.   Description : "flashes" the background colour of the given screen.
  335.         If screen is NULL, do a "flash" on all the screens.
  336.  
  337. DoubleClick (Intuition function)
  338.  
  339.   Synopsis    : result = DoubleClick( sec1, mic1, sec2, mic2 )
  340.  
  341.   Inputs      : sec1 (d0) - seconds of the first click
  342.         mic1 (d1) - microseconds of the first click
  343.         sec2 (d2) - seconds of the second click
  344.         mic2 (d3) - microseconds of the second click
  345.  
  346.   Outputs     : result (d0) - boolean
  347.  
  348.   Description : Returns FALSE if the time interval between the two
  349.         clicks is greater then the interval set for a double-click,
  350.         returns TRUE otherwise.
  351.  
  352.   See also    : CurrentTime.
  353.  
  354. DrawBorder (Intuition function)
  355.  
  356.   Synopsis    : DrawBorder( raster_port , border , x , y )
  357.  
  358.   Inputs      : raster_port (a0) pointer to a RastPort structure
  359.         border (a1) pointer to a Border structure
  360.         x (d0) value
  361.         y (d1) value
  362.  
  363.   Description : Draw the border specified by <border> into the given Raster
  364.         port, adding the x and y offsets to the coordinates in
  365.         each Border structure.
  366.  
  367.   See also    : Border.
  368.  
  369. DrawImage (Intuition function)
  370.  
  371.   Synopsis    : DrawImage( raster_port , image , x , y )
  372.  
  373.   Inputs      : raster_port (a0) pointer to a RastPort structure
  374.         image (a1) pointer to an Image structure
  375.         x (d0) value
  376.         y (d1) value
  377.  
  378.   Description : Draw the image specified by <image> into the given Raster
  379.         port, adding the x and y offsets to the image's position
  380.  
  381.   See also    : Image.
  382.  
  383. DupLock (Dos function)
  384.  
  385.   Synopsis    : lock1 = DupLock( lock2 )
  386.  
  387.   Inputs      : lock2 (d1) pointer to a FileLock structure
  388.  
  389.   Outputs     : lock1 (d0) pointer to a FileLock structure
  390.  
  391.   Description : Create a read lock on the same object as <lock2>.
  392.         This operation is not possible unless <lock2> is a read
  393.         lock.
  394.  
  395.   See also    : Lock.
  396.  
  397. EndRefresh (Intuition function)
  398.  
  399.   Synopsis    : EndRefresh( window , flag )
  400.  
  401.   Inputs      : window (a0) pointer to a Window structure
  402.         flag (d0) boolean
  403.  
  404.   Description : Tells Intuition that you are finished with the redrawing
  405.         of the given window.
  406.         If flag is TRUE, the window go back in the normal state,
  407.         otherwise it stays in special refresh state.
  408.  
  409.   See also    : BeginRefresh.
  410.  
  411. EndRequest (Intuition function)
  412.  
  413.   Synopsis    : EndRequest( requester , window )
  414.  
  415.   Inputs      : requester (a0) pointer to a Requester structure
  416.         window (a1) pointer to a Window structure.
  417.  
  418.   Description : Clear the requester box indicated.
  419.  
  420.   See also    : BuildSysRequest.
  421.  
  422. Examine (Dos function)
  423.  
  424.   Synopsis    : result = Examine( lock , block )
  425.  
  426.   Inputs      : lock (d1) pointer to a FileLock structure
  427.         block (d2) pointer to a FileInfoBlock structure
  428.  
  429.   Outputs     : result (d0) boolean
  430.  
  431.   Description : Copies certain informations on the given file or
  432.         directory, into a FileInfoBlock structure.
  433.         Returns 0 in case of failure, -1 in case of success.
  434.  
  435.   See also    : FileInfoBlock, Lock.
  436.  
  437. Execute (Dos function)
  438.  
  439.   Synopsis    : result = Execute( command , input , output )
  440.  
  441.   Inputs      : command (d1) pointer to a string of characters
  442.         input (d2) pointer to a FileHandle structure
  443.         output (d3) pointer to a FileHandle structure
  444.  
  445.   Outputs     : result (d0) boolean
  446.  
  447.   Description : Execute the given CLI command with <output> as the
  448.         standard output file. If <output> is 0, the current window
  449.         is used. The standard input is indicated by <input>.
  450.  
  451. Exit (Dos function)
  452.  
  453.   Synopsis    : Exit( code )
  454.  
  455.   Inputs      : code (d1) value
  456.  
  457.   Description : Terminate the current process, and returns the value <code>
  458.         to the calling process.
  459.  
  460. ExNext (Dos function)
  461.  
  462.   Synopsis    : result = ExNext( lock , block )
  463.  
  464.   Inputs      : lock (d1) pointer to a FileLock structure
  465.         block (d2) pointer to a FileInfoBlock structure
  466.  
  467.   Outputs     : result (d0) boolean
  468.  
  469.   Description : Copies certain information corresponding to the next entry
  470.         of the directory indicated, into a structure FileInfoBlock.
  471.         Returns 0 in case of failure, -1 in case of success.
  472.  
  473.   See also    : Examine, FileInfoBlock, Lock.
  474.  
  475. FileInfoBlock (Dos structure)
  476.  
  477.       struct FileInfoBlock {
  478.       LONG fib_DiskKey ;          /* Disk block number */
  479.       LONG fib_DirEntryType ;     /* Object type */
  480.       char fib_FileName[108] ;    /* Object name */
  481.       LONG fib_Protection ;       /* Protection bits */
  482.       LONG fib_EntryType ;
  483.       LONG fib_Size ;          /* Size in bytes */
  484.       LONG fib_NumBlocks ;          /* number of blocks used */
  485.       struct DateStamp fib_Date ; /* Date of last modification */
  486.       char fib_Comment[80] ;      /* comment */
  487.       } ;
  488.  
  489.       fib_DirEntryType : positive for a directory, negative for a file
  490.       fib_Protection   : see the SetProtection function
  491.  
  492.       See also     : Examine, ExNext.
  493.  
  494. FreeRemember (Intuition function)
  495.  
  496.   Synopsis    : FreeRemember( remember , everything )
  497.  
  498.   Inputs      : remember (a0) address of a pointer to a Remember structure
  499.         everything (d0) boolean
  500.  
  501.   Description : Free the memory allocated by the AllocRemember function. If
  502.         everything is TRUE the memory and the links are freed but
  503.         if everything is FALSE, just the links are freed.
  504.  
  505.   See also    : AllocRemember.
  506.  
  507. FreeSysRequest (Intuition function)
  508.  
  509.   Synopsis    : FreeSysRequest( window )
  510.  
  511.   Inputs      : window (a0) pointer to a Window structure
  512.  
  513.   Description : Free the memory allocated by the BuildSysRequest function.
  514.  
  515.   See also    : BuildSysRequest.
  516.  
  517. Gadget (Intuition structure)
  518.  
  519.     struct Gadget {
  520.       struct Gadget *NextGadget ;     /* next gadget structure */
  521.       SHORT  LeftEdge , TopEdge ;     /* x,y of the top left corner */
  522.       SHORT  Width , Height ;     /* width, height of the gadget */
  523.       USHORT Flags ;         /* see GadgetFlags */
  524.       USHORT Activation ;         /* see GadgetActivation */
  525.       USHORT GadgetType ;         /* see footnote */
  526.       APTR     GadgetRender ;      /* pointer to Image or Border */
  527.       APTR     SelectRender ;      /* pointer to Image or Border */
  528.       struct IntuiText *GadgetText ; /* associated text */
  529.       LONG     MutualExclude ;     /* gadget exclusion flags */
  530.       APTR     SpecialInfo ;         /* PropInfo or StringInfo pointer */
  531.       USHORT GadgetID ;         /* for programmer's own use */
  532.       APTR     UserData ;         /* for programmer's own use */
  533.       } ;
  534.  
  535.     GadgetType : BOOLGADGET, STRGADGET, PROPGADGET, GZZGADGET, REQGADGET
  536.  
  537.     See also   : AddGadget, Border, GadgetActivation, GadgetFlags, Image,
  538.              PropInfo, StringInfo.
  539.  
  540. GadgetActivation (a field in the structure Gadget)
  541.  
  542.     RELVERIFY      message only when mouse button was released over the gadget
  543.     GADGIMMEDIATE message as soon as gadget selected
  544.     ENDGADGET      clear the requester box (GadgetType = REQGADGET)
  545.     FOLLOWMOUSE   send messages MOUSEMOVE while gadget selected
  546.     RIGHTBORDER   position and width relative to right border of container
  547.     LEFTBORDER      position and width relative to left border of container
  548.     TOPBORDER      height and position relative to top border of container
  549.     BOTTOMBORDER  height and position relative to bottom border of container
  550.     TOGGLESELECT  toggle gadget (select/deselect)
  551.     STRINGCENTER  string centred (GadgetType = STRGADGET)
  552.     STRINGRIGHT   string right justified (GadgetType = STRGADGET)
  553.     LONGINT      only allow a 32 bit signed integer (GadgetType = STRGADGET)
  554.     ALTKEYMAP      see StringInfo
  555.  
  556.     See also   : Gadget, IDCMP, StringInfo.
  557.  
  558. GadgetFlags (a field in the structure Gadget)
  559.  
  560.     GADGHIGHBITS    (action when the gadget is selected)
  561.        GADGHCOMP    complement of the original image
  562.        GADGHBOX    draw a box
  563.        GADGHIMAGE    Display an alternative image/border
  564.        GADGHNONE    no highlighting
  565.     GADGIMAGE    GadgetRender and SelectRender are pointers to an
  566.             Image structure instead of a Border structure
  567.     GRELBOTTOM    TopEdge relative to bottom of displaying element
  568.     GRELRIGHT    LeftEdge relative to the right edge of the element
  569.     GRELWIDTH    Width is an increment to the width of the element
  570.     GRELHEIGHT    Height is an increment to the height of the element
  571.     SELECTED    gadget selected
  572.     GADGDISABLED    gadget activated
  573.  
  574.     See also   : Gadget.
  575.  
  576. GetDefPrefs (Intuition function)
  577.  
  578.   Synopsis    : prefs = GetDefPrefs( buffer , size )
  579.  
  580.   Inputs      : buffer (a0) pointer to a Preferences structure
  581.         size (d0) value
  582.  
  583.   Outputs     : prefs (d0) pointer to a Preferences structure
  584.  
  585.   Description : Copies the default preferences (those Intuition uses
  586.         if none others). Only the first <size> bytes are
  587.         copied.
  588.         The value returned is a copy of the parameter <buffer>, or
  589.         NULL in case of problems.
  590.  
  591.   See also    : GetPrefs.
  592.  
  593. GetPrefs (Intuition function)
  594.  
  595.   Synopsis    : prefs = GetPrefs( buffer , size )
  596.  
  597.   Inputs      : buffer (a0) pointer to a Preferences structure
  598.         size (d0) value
  599.  
  600.   Outputs     : prefs (d0) pointer to a Preferences structure
  601.  
  602.   Description : Copy the preferences settings. Only the first <size>
  603.         bytes are copied.
  604.         The value returned is a copy of the parameter <buffer>, or
  605.         NULL in case of problems.
  606.  
  607.   See also    : GetDefPrefs.
  608.  
  609. IDCMP (Port message Intuition, classes of messages)
  610.  
  611.     SIZEVERIFY       user wants to change window size
  612.     NEWSIZE       used has resized the window
  613.     REFRESHWINDOW  window needs refreshing
  614.     MOUSEBUTTONS   mouse button (code SELECTUP,SELECTDOWN,MENUUP,MENUDOWN)
  615.     MOUSEMOVE       the mouse has moved
  616.     GADGETDOWN       SELECTDOWN and GadgetActivation = GADGIMMEDIATE
  617.     GADGETUP       SELECTUP and GadgetActivation = RELVERIFY
  618.     REQSET       requester box has been opened
  619.     MENUPICK       menu selection finished
  620.     CLOSEWINDOW    close gadget selected
  621.     RAWKEY       a key has been pressed (raw key codes)
  622.     REQVERIFY       a requester box is about to be activated
  623.     REQCLEAR       last requester box cleared
  624.     MENUVERIFY       a menu selection is about to take place
  625.     NEWPREFS       Preferences changes
  626.     DISKINSERTED   diskette inserted
  627.     DISKREMOVED    diskette removed
  628.     ACTIVEWINDOW   window activated
  629.     INACTIVEWINDOW window deactivated
  630.     VANILLAKEY       key pressed (ASCII key codes)
  631.     INTUITICKS       time signal (usually 10 per second)
  632.  
  633.     See also   : AutoRequest, BuildSysRequest, NewWindow, ModifyIDCMP.
  634.  
  635. Image (Intuition structure)
  636.  
  637.     struct Image {
  638.       SHORT  LeftEdge ;      /* x of top left corner */
  639.       SHORT  TopEdge ;      /* y of top left corner */
  640.       SHORT  Width ;      /* width */
  641.       SHORT  Height , Depth ; /* height, number of plans */
  642.       USHORT *ImageData ;      /* pointer to image definition */
  643.       UBYTE  PlanePick ,      /* mask planes used */
  644.          PlaneOnOff ;      /* mask planes unused */
  645.       struct Image *NextImage ;
  646.       } ;
  647.  
  648.     See also   : DrawImage, Gadget, NewWindow.
  649.  
  650. Info (Dos function)
  651.  
  652.   Synopsis    : result = Info( lock , block )
  653.  
  654.   Inputs      : lock (d1) pointer to a FileLock structure
  655.         block (d2) pointer to an InfoData structure
  656.  
  657.   Outputs     : result (d0) boolean
  658.  
  659.   Description : Copies certain information on the volume where the given
  660.         file or directory designated by the lock is located, into a
  661.         structure InfoData.
  662.         Returns 0 in case of failure, -1 in case of success.
  663.  
  664.   See also    : InfoData, Lock.
  665.  
  666. InfoData (Dos structure)
  667.  
  668.       struct InfoData {
  669.       LONG id_NumSoftErrors ; /* number of errors on the volume */
  670.       LONG id_UnitNumber ;      /* Disk unit number of this volume */
  671.       LONG id_DiskState ;      /* State of the volume */
  672.       LONG id_NumBlocks ;      /* number of blocks on the volume */
  673.       LONG id_NumBlocksUsed ; /* number of blocks used */
  674.       LONG id_BytesPerBlock ; /* number of bytes per block */
  675.       LONG id_DiskType ;      /* Type of the volume */
  676.       BPTR id_VolumeNode ;
  677.       LONG id_InUse ;
  678.       } ;
  679.  
  680.       id_DiskState : ID_WRITE_PROTECTED, ID_VALIDATING, ID_VALIDATED
  681.       id_DiskType  : ID_NO_DISK_PRESENT, ID_UNREADABLE_DISK, ID_DOS_DISK,
  682.              ID_NOT_REALLY_DOS, ID_KICKSTART_DISK
  683.  
  684.       See also     : Info.
  685.  
  686. Input (Dos function)
  687.  
  688.   Synopsis    : file = Input()
  689.  
  690.   Outputs     : file (d0) pointer to a FileHandle structure
  691.  
  692.   Description : Returns the file handle of the current input file.
  693.  
  694.   See also    : Output.
  695.  
  696. IntuiText (Intuition structure)
  697.  
  698.     struct IntuiText {
  699.       UBYTE  FrontPen , BackPen ;  /* text color, background color */
  700.       UBYTE  DrawMode ;           /* JAM1, JAM2, XOR */
  701.       SHORT  LeftEdge ;           /* x of first character */
  702.       SHORT  TopEdge ;           /* y of first character */
  703.       struct TextAttr *ITextFont ; /* font to use */
  704.       UBYTE  *IText ;           /* string to draw */
  705.       struct IntuiText *NextText ; /* similar structure */
  706.       } ;
  707.  
  708.     See also   : AutoRequest, BuildSysRequest, Gadget, IntuiTextLength,
  709.              PrintIText.
  710.  
  711. IntuiTextLength (Intuition function)
  712.  
  713.   Synopsis    : length = IntuiTextLength( text )
  714.  
  715.   Inputs      : text (a0) pointer to an IntuiText structure
  716.  
  717.   Outputs     : length (d0) value
  718.  
  719.   Description : Returns the length, in number of pixels, of the string of the
  720.         given IntuiText structure (this depends of the size of the
  721.         font).
  722.  
  723.   See also    : IntuiText.
  724.  
  725. IoErr (Dos function)
  726.  
  727.   Synopsis    : error = IoErr()
  728.  
  729.   Outputs     : error (d0) value
  730.  
  731.   Description : Returns the code of the last error encountered, or a
  732.         secondary result.
  733.  
  734.   See also    : DeviceProc.
  735.  
  736. IsInteractive (Dos function)
  737.  
  738.   Synopsis    : result = IsInteractive( file )
  739.  
  740.   Inputs      : file (d1) pointer to a FileHandle structure
  741.  
  742.   Outputs     : result (d0) boolean
  743.  
  744.   Description : Returns -1 if the given file corresponds to a virtual
  745.         terminal, 0 if not.
  746.  
  747.   See also    : Open.
  748.  
  749. ItemAddress (Intuition function)
  750.  
  751.   Synopsis    : adr = ItemAddress( menu , code )
  752.  
  753.   Inputs      : menu (a0) pointer to the first Menu structure of a
  754.               menu bars
  755.         code (d0) value
  756.  
  757.   Outputs     : adr (d0) pointer to a MenuItem structure
  758.  
  759.   Description : Returns the address of the MenuItem structure corresponding
  760.         to the given code (the code is send by Intuition in a
  761.         message of MENUPICK class).
  762.  
  763. Lock (Dos function)
  764.  
  765.   Synopsis    : lock = Lock( name , access )
  766.  
  767.   Inputs      : name (d1) pointer to a string of characters
  768.         access (d2) value (ACCESS_READ or ACCESS_WRITE)
  769.  
  770.   Outputs     : lock (d0) pointer to a FileLock structure
  771.  
  772.   Description : Returns a read or write lock (depending on the the value
  773.         of access) on the given file or on the directory.
  774.         The lock returned is null in case of failure.
  775.  
  776.   See also    : UnLock.
  777.  
  778. LoadSeg (Dos function)
  779.  
  780.   Synopsis    : segment = LoadSeg( name )
  781.  
  782.   Inputs      : name (d1) pointer to a string of characters
  783.  
  784.   Outputs     : segment (d0) pointer to a list of segments
  785.  
  786.   Description : Load the given executable file in memory, and returns
  787.         a pointer to the list of allocated segments (or 0 in case of
  788.         error).
  789.  
  790.   See also    : CreateProc, UnLoadSeg.
  791.  
  792. ModifyIDCMP (Intuition function)
  793.  
  794.   Synopsis    :  ModifyIDCMP( window , IDCMP )
  795.  
  796.   Inputs      : window (a0) pointer to a Window structure
  797.         IDCMP (d0) new IDCMP flags
  798.  
  799.   Description : Modifies the IDCMP flags of the given window.
  800.  
  801.   See also    : IDCMP.
  802.  
  803. ModifyProp (Intuition function)
  804.  
  805.   Synopsis    : ModifyProp( gadget, window , requester , flags , horiz_pot,
  806.                 vert_pot, horiz_body, vert_body )
  807.  
  808.   Inputs      : gadget (a0) pointer to a Gadget structure
  809.         window (a1) pointer to a Window or a Screen structure
  810.         requester (a2) pointer to a Requester structure
  811.         flags (d0) value
  812.         horiz_pot (d1) value
  813.         vert_pot (d2) value
  814.         horiz_body (d3) value
  815.         vert_body (d4) value
  816.  
  817.   Description : Modifies a proportional gadget. The parameters flags,
  818.         <horiz_pot>, <vert_pot>, <horiz_body> and <vert_body> are
  819.         copied in the fields Flags, HorizPot, VertPot, HorizBody and
  820.         VertBody of the structure PropInfo corresponding to the gadget.
  821.         The parameter <window> indicates the window or the screen
  822.         housing the gadget, and the parameter <requester> the requester
  823.         box to which the gadget is attached (otherwise NULL).
  824.  
  825.   See also    : PropInfo.
  826.  
  827. MoveScreen (Intuition function)
  828.  
  829.   Synopsis    : MoveScreen( screen , x , y )
  830.  
  831.   Inputs      : screen (a0) pointer to a Screen  structure
  832.         x (d0) value
  833.         y (d1) value
  834.  
  835.   Description : Move the given screen.
  836.  
  837. MoveWindow (Intuition function)
  838.  
  839.   Synopsis    : MoveWindow( window , x , y )
  840.  
  841.   Inputs      : window (a0) pointer to a Window structure
  842.         x (d0) value
  843.         y (d1) value
  844.  
  845.   Description : Move the given window.
  846.  
  847. NewScreen (Intuition structure)
  848.  
  849.     struct NewScreen {
  850.       SHORT  LeftEdge , TopEdge ;    /* ignored, top line */
  851.       SHORT  Width , Height ;    /* width, height */
  852.       SHORT  Depth ;        /* number of planes */
  853.       UBYTE  DetailPen , BlockPen ; /* details color, blocks color */
  854.       USHORT ViewModes ;        /* HIRES,INTERLACE,SPRITES,DUALPF */
  855.       USHORT Type ;         /* CUSTOMSCREEN,CUSTOMBITMAP */
  856.       struct TextAttr *Font ;    /* font used */
  857.       UBYTE  *DefaultTitle ;    /* title of the screen */
  858.       struct Gadget *Gadgets ;    /* gadgets attached to the screen */
  859.       struct BitMap *CustomBitMap ;
  860.       } ;
  861.  
  862.     See also   : Gadget, OpenScreen.
  863.  
  864. NewWindow (Intuition structure)
  865.  
  866.     struct NewWindow {
  867.       SHORT  LeftEdge , TopEdge ;    /* x,y coin top left */
  868.       SHORT  Width , Height ;    /* width, height */
  869.       UBYTE  DetailPen , BlockPen ; /* details color, blocks color */
  870.       ULONG  IDCMPFlags ;        /* see IDCMP */
  871.       ULONG  Flags ;        /* see WindowFlags */
  872.       struct Gadget *FirstGadget ;    /* gadgets attached to that window */
  873.       struct Image *CheckMark ;    /* Image for ticked menus */
  874.       UBYTE  *Title ;        /* title of the window */
  875.       struct Screen *Screen ;    /* screen on which the window is */
  876.       struct BitMap *BitMap ;
  877.       SHORT  MinWidth , MinHeight ; /* minimum size */
  878.       USHORT MaxWidth , MaxHeight ; /* maximum size */
  879.       USHORT Type ;         /* WBENCHSCREEN, CUSTOMSCREEN */
  880.       } ;
  881.  
  882.     See also   : Gadget, IDCMP, Image, OpenWindow, WindowFlags.
  883.  
  884. OffGadget (Intuition function)
  885.  
  886.   Synopsis    : OffGadget( gadget , window , requester )
  887.  
  888.   Inputs      : gadget (a0) pointer to a Gadget structure
  889.         window (a1) pointer to a Window structure
  890.         requester (a2) pointer to a Requester structure
  891.  
  892.   Description : Disable the given gadget. The argument <requester>
  893.         should be NULL, when the gadget is not in a requester box
  894.         The image of the gadget will not be modified until you
  895.         call the function RefreshGadgets.
  896.  
  897.   See also    : OnGadget, RefreshGadgets.
  898.  
  899. OffMenu (Intuition function)
  900.  
  901.   Synopsis    : OffMenu( window , code_menu )
  902.  
  903.   Inputs      : window (a0) pointer to a Window structure
  904.         code_menu (d0) value
  905.  
  906.   Description : Disable a sub-menu, a option, or a complete menu.
  907.  
  908.   See also    : OnMenu.
  909.  
  910. OnGadget (Intuition function)
  911.  
  912.   Synopsis    : OnGadget( gadget , window , requester )
  913.  
  914.   Inputs      : gadget (a0) pointer to a Gadget structure
  915.         window (a1) pointer to a Window structure
  916.         requester (a2) pointer to a Requester structure
  917.  
  918.   Description : Enable the given gadget. The argument <requester> should
  919.         be NULL if the gadget is not in a requester box
  920.         The image of the gadget will not be modified until you
  921.         call the function RefreshGadgets.
  922.  
  923.   See also    : OffGadget, RefreshGadgets.
  924.  
  925. OnMenu (Intuition function)
  926.  
  927.   Synopsis    : OnMenu( window , code_menu )
  928.  
  929.   Inputs      : window (a0) pointer to a Window structure
  930.         code_menu (d0) value
  931.  
  932.   Description : Enable a sub-menu, a option, or an entire menu.
  933.  
  934.   See also    : OffMenu.
  935.  
  936. Open (Dos function)
  937.  
  938.   Synopsis    : file = Open( name , access )
  939.  
  940.   Inputs      : name (d1) pointer to a string of characters
  941.         access (d2) value (MODE_OLDFILE or MODE_NEWFILE)
  942.  
  943.   Outputs     : file (d0) pointer to a FileHandle structure
  944.  
  945.   Description : Open the given file for reading or writing (defined by
  946.         the value of access) and returns a pointer to a FileHandle
  947.         structure, or 0 in case of failure.
  948.  
  949.   See also    : Close.
  950.  
  951. OpenScreen (Intuition function)
  952.  
  953.   Synopsis    : screen = OpenScreen( nscreen )
  954.  
  955.   Inputs      : nscreen (a0) pointer to a NewScreen structure
  956.  
  957.   Outputs     : screen (d0) pointer to a Screen structure
  958.  
  959.   Description : Open a custom screen as specified by the NewScreen structure,
  960.         and returns a pointer to the corresponding Screen structure
  961.         (NULL in case of problems).
  962.  
  963.   See also    : CloseScreen, NewScreen.
  964.  
  965. OpenWindow (Intuition function)
  966.  
  967.   Synopsis    : window = OpenWindow( nwindow )
  968.  
  969.   Inputs      : nwindow (a0) pointer to a NewWindow structure
  970.  
  971.   Outputs     : window (d0) pointer to a Window structure
  972.  
  973.   Description : Open a window as specified by the NewWindow structure,
  974.         and returns a pointer to the corresponding Window structure
  975.         (NULL in case of problems).
  976.  
  977.   See also    : CloseWindow, NewWindow.
  978.  
  979.  
  980. OpenWorkBench (Intuition function)
  981.  
  982.   Synopsis    : result = OpenWorkBench()
  983.  
  984.   Outputs     : result (d0) boolean
  985.  
  986.   Description : Open the WorkBench screen. Returns TRUE if all went
  987.         well and FALSE otherwise.
  988.  
  989.   See also    : CloseWorkBench.
  990.  
  991. Output (Dos function)
  992.  
  993.   Synopsis    : file = Output()
  994.  
  995.   Outputs     : file (d0) pointer to a FileHandle structure
  996.  
  997.   Description : Returns the FileHandle of the current output file.
  998.  
  999.   See also    : Input.
  1000.  
  1001. ParentDir (Dos function)
  1002.  
  1003.   Synopsis    : lock1 = ParentDir( lock2 )
  1004.  
  1005.   Inputs      : lock2 (d1) pointer to a FileLock structure
  1006.  
  1007.   Outputs     : lock1 (d0) pointer to a FileLock structure
  1008.  
  1009.   Description : Returns a read lock corresponding to parent directory
  1010.         of the file or directory corresponding to <lock2>.
  1011.         This lock may be NULL (this denotes the root directory
  1012.         of the volume).
  1013.  
  1014.   See also    : CurrentDir, Lock.
  1015.  
  1016. PrintIText (Intuition function)
  1017.  
  1018.   Synopsis    : PrintIText( raster_port, text , x , y )
  1019.  
  1020.   Inputs      : raster_port (a0) pointer to a RastPort structure
  1021.         text (a1) pointer to a IntuiText structure
  1022.         x (d0) value
  1023.         y (d1) value
  1024.  
  1025.   Description : Draw the text into the given Raster port, adding the x and
  1026.         y offsets to each coords.
  1027.  
  1028.   See also    : IntuiText.
  1029.  
  1030. PropInfo (Intuition structure)
  1031.  
  1032.     struct PropInfo
  1033.     {
  1034.       USHORT Flags ;        /* see footnote */
  1035.       USHORT HorizPot ;        /* horizontal percentage */
  1036.       USHORT VertPot ;        /* vertical percentage */
  1037.       USHORT HorizBody ;        /* horizontal increment */
  1038.       USHORT VertBody ;        /* vertical increment */
  1039.       USHORT CWidth ;        /* width of the container */
  1040.       USHORT CHeight ;        /* height of the container */
  1041.       USHORT HPotRes, VPotRes ;
  1042.       USHORT LeftBorder ;        /* border left of the container */
  1043.       USHORT TopBorder ;        /* border top of the container */
  1044.       } ;
  1045.  
  1046.     Flags : AUTOKNOB, FREEHORIZ, FREEVERT, PROPBORDERLESS, KNOBHIT
  1047.  
  1048.     See also   : Gadget, ModifyProp.
  1049.  
  1050. Read (Dos function)
  1051.  
  1052.   Synopsis    : result = Read( file , buffer , length )
  1053.  
  1054.   Inputs      : file (d1) pointer to a FileHandle structure
  1055.         buffer (d2) pointer to a buffer
  1056.         length (d3) value
  1057.  
  1058.   Outputs     : result (d0) value
  1059.  
  1060.   Description : Read the given number of bytes from a file,
  1061.         and place the data at memory pointed to by <buffer>.
  1062.         Returns the number of bytes read, -1 in case of error,
  1063.         and 0 at end of file.
  1064.  
  1065.   See also    : Open.
  1066.  
  1067. RefreshGadgets (Intuition function)
  1068.  
  1069.   Synopsis    : RefreshGadgets( gadget , window , requester )
  1070.  
  1071.   Inputs      : gadget (a0) pointer to a Gadget structure
  1072.         window (a1) pointer to a Window structure
  1073.         requester (a2) pointer to a Requester structure
  1074.  
  1075.   Description : Refreshes the list of gadgets in one window, starting at
  1076.         then given gadget. The argument <requester> must be NULL if
  1077.         the gadget is not in a requester box.
  1078.  
  1079. RemoveGadget (Intuition function)
  1080.  
  1081.   Synopsis    : result = RemoveGadget( window , gadget )
  1082.  
  1083.   Inputs      : window (a0) pointer to a Window structure
  1084.         gadget (a1) pointer to a Gadget structure
  1085.  
  1086.   Outputs     : result (d0) value
  1087.  
  1088.   Description : Remove the given gadget from the window's list of gadgets.
  1089.         Returns the former position of the gadget, or -1 in case of
  1090.         problems.
  1091.         The gadget image will not be deleted, until you call the
  1092.         function RefreshGadgets.
  1093.  
  1094.   See also    : AddGadget, RefreshGadgets.
  1095.  
  1096. Rename (Dos function)
  1097.  
  1098.   Synopsis    : result = Rename( name1 , name2 )
  1099.  
  1100.   Inputs      : name1 (d1) pointer to a string of characters
  1101.         name2 (d2) pointer to a string of characters
  1102.  
  1103.   Outputs     : result (d0) boolean
  1104.  
  1105.   Description : Rename the file or directory designated by <name1> as
  1106.         <name2>.
  1107.         Returns 0 in case of failure, -1 in case of success.
  1108.  
  1109. ReportMouse (Intuition function)
  1110.  
  1111.   Synopsis    : ReportMouse( window , flag )
  1112.  
  1113.   Inputs      : window (a0) pointer to a Window structure
  1114.         indic (d0) boolean
  1115.  
  1116.   Description : Enable (flag = TRUE) or disable (flag = FALSE) the sending
  1117.         of messages reporting the position of the mouse.
  1118.  
  1119.   See also    : IDCMP.
  1120.  
  1121. Request (Intuition function)
  1122.  
  1123.   Synopsis    : result = Request( requester , window )
  1124.  
  1125.   Inputs      : requester (a0) pointer to a Requester structure
  1126.         window (a1) pointer to a Window structure
  1127.  
  1128.   Outputs     : result (d0) boolean
  1129.  
  1130.   Description : Open a requester box into the given window.
  1131.         Returns TRUE if all went well, FALSE in case of problems.
  1132.  
  1133. ScreenToBack (Intuition function)
  1134.  
  1135.   Synopsis    : ScreenToBack( screen )
  1136.  
  1137.   Inputs      : screen (a0) pointer to a Screen structure
  1138.  
  1139.   Description : Send the given screen to the back plan.
  1140.  
  1141.   See also    : ScreenToFront.
  1142.  
  1143. ScreenToFront (Intuition function)
  1144.  
  1145.   Synopsis    : ScreenToFront( screen )
  1146.  
  1147.   Inputs      : screen (a0) pointer to a Screen structure
  1148.  
  1149.   Description : Pushes the given screen to the first plan.
  1150.  
  1151.   See also    : ScreenToBack.
  1152.  
  1153. Seek (Dos function)
  1154.  
  1155.   Synopsis    : result = Seek( file , position , mode )
  1156.  
  1157.   Inputs      : file (d1) pointer to a FileHandle structure
  1158.         position (d2) value
  1159.         mode (d3) value (OFFSET_BEGINNING,OFFSET_CURRENT,OFFSET_END)
  1160.  
  1161.   Outputs     : result (d0) boolean
  1162.  
  1163.   Description : Place the read/write pointer of the given file at the point
  1164.         designated by the position (relative to the start of the file,
  1165.         to the current position, or to the end of file depending on the
  1166.         value of mode).
  1167.         Returns the former position (relative to the start of file)
  1168.         or -1 in case of error.
  1169.  
  1170.   See also    : Open.
  1171.  
  1172. SetComment (Dos function)
  1173.  
  1174.   Synopsis    : result = SetCommand( name , comment )
  1175.  
  1176.   Inputs      : name (d1) pointer to a string of characters
  1177.         comment (d2) pointer to a string of characters
  1178.  
  1179.   Outputs     : result (d0) boolean
  1180.  
  1181.   Description : Add a file comment on the given file or directory.
  1182.         Returns 0 upon failure, -1 in case of success.
  1183.  
  1184. SetDMRequest (Intuition function)
  1185.  
  1186.   Synopsis    : result = SetDMRequest( window , requester )
  1187.  
  1188.   Inputs      : window (a0) pointer to a Window structure
  1189.         requester (a1) pointer to a Requester structure
  1190.  
  1191.   Outputs     : result (d0) value
  1192.  
  1193.   Description : Attach a requester box to the given window. This
  1194.         requester box is activated when the double-click on the
  1195.         mouse MENU button.
  1196.         Returns TRUE if all went well, FALSE in case of problems.
  1197.  
  1198.   See also    : ClearDMRequest.
  1199.  
  1200. SetMenuStrip (Intuition function)
  1201.  
  1202.   Synopsis    : SetMenuStrip( window , menu )
  1203.  
  1204.   Inputs      : window (a0) pointer to a Window structure
  1205.         menu (a1) pointer to a Menu structure
  1206.  
  1207.   Description : Set the menu bar of the given window.
  1208.  
  1209.   See also    : ClearMenuStrip.
  1210.  
  1211. SetPointer (Intuition function)
  1212.  
  1213.   Synopsis    : SetPointer( window , def , height , width , x , y )
  1214.  
  1215.   Inputs      : window (a0) pointer to a Window structure
  1216.         def (a1) pointer to the pointer definition
  1217.         height (d0) value
  1218.         width (d1) value
  1219.         x (d2) value
  1220.         y (d3) value
  1221.  
  1222.   Description : Change the definition of the pointer for the given window.
  1223.         The size of the pointer is given by the parameters <height>
  1224.         and <width< (which must be <= 16 low-res pixels).
  1225.         The parameters <x> and <y> indicate the offset of the
  1226.         'hot spot' of the pointer.
  1227.  
  1228.   See also    : ClearPointer.
  1229.  
  1230. SetProtection (Dos function)
  1231.  
  1232.   Synopsis    : result = SetProtection( name , mask )
  1233.  
  1234.   Inputs      : name (d1) pointer to a string of characters
  1235.         mask (d2) value
  1236.  
  1237.   Outputs     : result (d0) boolean
  1238.  
  1239.   Description : Change the protection bits of the file indicated to value
  1240.         of <mask> :
  1241.  
  1242.                bit 0 : d (delete)   bit 4 : a (archived)
  1243.                bit 1 : e (execute)  bit 5 : p (pure)
  1244.                bit 2 : w (write)    bit 6 : s (script)
  1245.                bit 3 : r (read)     bit 7 : h (hidden)
  1246.  
  1247. SetWindowTitles (Intuition function)
  1248.  
  1249.   Synopsis    : SetWindowTitles( window , title_f , title_e )
  1250.  
  1251.   Inputs      : window (a0) pointer to a Window structure
  1252.         title_f (a1) pointer to a string of characters
  1253.         title_e (a2) pointer to a string of characters
  1254.  
  1255.   Description : Change the title of the given window and/or of the screen
  1256.         that holds that window.
  1257.         If <title_f> is -1 the old title of the window is kept,
  1258.         0 the old title is cleared, otherwise the old title is
  1259.         replaced with the given string.
  1260.         If <title_e> is -1 the old title of the screen is kept,
  1261.         0 the old title is cleared, otherwise the old title is
  1262.         replaced with the given string.
  1263.  
  1264.   See also    : ShowTitle.
  1265.  
  1266. ShowTitle (Intuition function)
  1267.  
  1268.   Synopsis    : ShowTitle( screen , flag )
  1269.  
  1270.   Inputs      : screen (a0) pointer to a Screen structure
  1271.         flag (d0) boolean
  1272.  
  1273.   Description : Show (flag = TRUE) or hide (flag = FALSE) the title
  1274.         of the given screen.
  1275.  
  1276.   See also    : SetWindowTitles.
  1277.  
  1278. SizeWindow (Intuition function)
  1279.  
  1280.   Synopsis    : SizeWindow( window , x , y )
  1281.  
  1282.   Inputs      : window (a0) pointer to a Window structure
  1283.         x (d0) value
  1284.         y (d1) value
  1285.  
  1286.   Description : Change the size of the given window to width <x> and height <y>
  1287.  
  1288. StringInfo (Intuition structure)
  1289.  
  1290.     struct StringInfo {
  1291.       UBYTE  *Buffer ;         /* buffer for the string */
  1292.       UBYTE  *UndoBuffer ;         /* edit buffer */
  1293.       SHORT  BufferPos ;         /* position in the buffer */
  1294.       SHORT  MaxChars ;         /* maximum size of the string */
  1295.       SHORT  DispPos ;         /* position of 1st character displayed */
  1296.       SHORT  UndoPos ;         /* position in the edit buffer */
  1297.       SHORT  NumChars ;         /* number of characters in the buffer */
  1298.       SHORT  DispCount ;         /* number of characters visible */
  1299.       SHORT  CLeft , CTop ;      /* x,y of the top left corner */
  1300.       struct Layer *LayerPtr ;
  1301.       LONG     LongInt ;         /* value corresponding to the string */
  1302.       struct KeyMap *AltKeyMap ; /* character translation table */
  1303.       } ;
  1304.  
  1305.     LongInt is not used unless GadgetActivation = LONGINT
  1306.     AltKeyMap is not used unles GadgetActivation = ALTKEYMAP
  1307.  
  1308.     See also   : GadgetActivation, Gadget.
  1309.  
  1310. UnLoadSeg (Dos function)
  1311.  
  1312.   Synopsis    : UnLoadSeg( segment )
  1313.  
  1314.   Inputs      : segment (d1) pointer to a list of segments
  1315.  
  1316.   Description : Free a list of segments.
  1317.  
  1318.   See also    : LoadSeg.
  1319.  
  1320. UnLock (Dos function)
  1321.  
  1322.   Synopsis    : UnLock( lock )
  1323.  
  1324.   Inputs      : lock (d1) pointer to a FileLock structure
  1325.  
  1326.   Description : Free an access lock.
  1327.  
  1328.   See also    : Lock.
  1329.  
  1330. WaitForChar (Dos function)
  1331.  
  1332.   Synopsis    : result = WaitForChar( file , delay )
  1333.  
  1334.   Inputs      : file (d1) pointer to a FileHandle structure
  1335.         delay (d2) value
  1336.  
  1337.   Outputs     : result (d0) boolean
  1338.  
  1339.   Description : Wait for <delay> micro-seconds for data entered on the
  1340.         terminal corresponding to the given file.
  1341.         Returns -1 if the data is present, 0 if not.
  1342.  
  1343.   See also    : Open, Read, IsInteractive.
  1344.  
  1345. WBenchToBack (Intuition function)
  1346.  
  1347.   Synopsis    : result = WBenchToBack()
  1348.  
  1349.   Outputs     : result (d0) boolean
  1350.  
  1351.   Description : Open the WorkBench screen and place it on backmost plan.
  1352.         Returns TRUE if all went well, FALSE if the WorkBench screen
  1353.         couldn't be opened
  1354.  
  1355. WBenchToFront (Intuition function)
  1356.  
  1357.   Synopsis    : result = WBenchToFront()
  1358.  
  1359.   Outputs     : result (d0) boolean
  1360.  
  1361.   Description : Open the WorkBench screen and place it on first plan.
  1362.         Returns TRUE if all went well, FALSE if the WorkBench screen
  1363.         couldn't be opened
  1364.  
  1365. WindowFlags (field in the NewWindow structure)
  1366.  
  1367.     WINDOWSIZING     Add size gadget
  1368.     WINDOWDRAG     Add drag gadget
  1369.     WINDOWDEPTH     Add depth gadget
  1370.     WINDOWCLOSE     Add close gadget
  1371.     SMART_REFRESH     refreshing handled by Intuition
  1372.     SIMPLE_REFRESH     refreshing handled by the program
  1373.     NOCAREREFRESH     forget refreshing
  1374.     BACKDROP     window positioned en backmost plan
  1375.     REPORTMOUSE     send the MOUSEMOVE messages
  1376.     BORDERLESS     don't trace the border of the window
  1377.     RMBTRAP      don't call a menu when MENUDOWN
  1378.  
  1379.     See also   : NewWindow.
  1380.  
  1381. WindowLimits (Intuition function)
  1382.  
  1383.   Synopsis    : result = WindowLimits( window, l_min, h_min, l_max, h_max )
  1384.  
  1385.   Inputs      : window (a0) pointer to a Window structure
  1386.         l_min (d0) value
  1387.         h_min (d1) value
  1388.         l_max (d2) value
  1389.         h_max (d3) value
  1390.  
  1391.   Outputs     : result (d0) boolean
  1392.  
  1393.   Description : Change the size limits of the given window, and copies the
  1394.         values <l_min>, <h_min>, <l_max> and <h_max> into the
  1395.         fields MinWidth, MinHeight, MaxWidth and MaxHeight of the
  1396.         Window structure.
  1397.         Returns TRUE if all went well, FALSE in the case of
  1398.         problems.
  1399.  
  1400. WindowToBack (Intuition function)
  1401.  
  1402.   Synopsis    : WindowToBack( window )
  1403.  
  1404.   Inputs      : window (a0) pointer to a Window structure
  1405.  
  1406.   Description : Place the given window in the back plan.
  1407.  
  1408.   See also    : WindowToFront.
  1409.  
  1410. WindowToFront (Intuition function)
  1411.  
  1412.   Synopsis    : WindowToFront( window )
  1413.  
  1414.   Inputs      : window (a0) pointer to a Window structure
  1415.  
  1416.   Description : Place the given window to the first plan.
  1417.  
  1418.   See also    : WindowToBack.
  1419.  
  1420. Write (Dos function)
  1421.  
  1422.   Synopsis    : result = Write( file , buffer , length )
  1423.  
  1424.   Inputs      : file (d1) pointer to a FileHandle structure
  1425.         buffer (d2) pointer to a buffer
  1426.         length (d3) value
  1427.  
  1428.   Outputs     : result (d0) value
  1429.  
  1430.   Description : Write the given number of bytes of data from the
  1431.         buffer to the file.
  1432.         Returns the number of bytes written, or -1 in case of error.
  1433.  
  1434.   See also    : Open.
  1435.  
  1436.  
  1437.